<!DOCTYPE html>
<html lang="en-US">
<head>
    <meta charset="UTF-8"/>
    <meta name="viewport" content="width=device-width, initial-scale=1">
    <meta name="language" content="en" />
        <link href="./assets/ffd55088/css/bootstrap.css" rel="stylesheet">
<link href="./assets/5cf9384a/solarized_light.css" rel="stylesheet">
<link href="./assets/6c54116e/style.css" rel="stylesheet">
<script src="./assets/a44cef0f/jquery.js"></script>
<script src="./assets/ffd55088/js/bootstrap.js"></script>
<script src="./assets/8ac4e28a/jssearch.js"></script>    <title>Module, yii\debug\Module - Yii Framework 2.0 API Documentation</title>
</head>
<body>

<div class="wrap">
    <nav id="w12305" class="navbar-inverse navbar-fixed-top navbar" role="navigation"><div class="navbar-header"><button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#w12305-collapse"><span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span></button><a class="navbar-brand" href="./index.html">Yii Framework 2.0 API Documentation</a></div><div id="w12305-collapse" class="collapse navbar-collapse"><ul id="w12306" class="navbar-nav nav"><li><a href="./index.html">Class reference</a></li>
<li class="dropdown"><a class="dropdown-toggle" href="#" data-toggle="dropdown">Extensions <b class="caret"></b></a><ul id="w12307" class="dropdown-menu"><li><a href="./ext-apidoc-index.html" tabindex="-1">apidoc</a></li>
<li><a href="./ext-authclient-index.html" tabindex="-1">authclient</a></li>
<li><a href="./ext-bootstrap-index.html" tabindex="-1">bootstrap</a></li>
<li><a href="./ext-codeception-index.html" tabindex="-1">codeception</a></li>
<li><a href="./ext-debug-index.html" tabindex="-1">debug</a></li>
<li><a href="./ext-elasticsearch-index.html" tabindex="-1">elasticsearch</a></li>
<li><a href="./ext-faker-index.html" tabindex="-1">faker</a></li>
<li><a href="./ext-gii-index.html" tabindex="-1">gii</a></li>
<li><a href="./ext-imagine-index.html" tabindex="-1">imagine</a></li>
<li><a href="./ext-jui-index.html" tabindex="-1">jui</a></li>
<li><a href="./ext-mongodb-index.html" tabindex="-1">mongodb</a></li>
<li><a href="./ext-redis-index.html" tabindex="-1">redis</a></li>
<li><a href="./ext-smarty-index.html" tabindex="-1">smarty</a></li>
<li><a href="./ext-sphinx-index.html" tabindex="-1">sphinx</a></li>
<li><a href="./ext-swiftmailer-index.html" tabindex="-1">swiftmailer</a></li>
<li><a href="./ext-twig-index.html" tabindex="-1">twig</a></li></ul></li>
<li><a href="./guide-README.html">Guide</a></li></ul><div class="navbar-form navbar-left" role="search">
  <div class="form-group">
    <input id="searchbox" type="text" class="form-control" placeholder="Search">
  </div>
</div>
</div></nav>
    <div id="search-resultbox" style="display: none;" class="modal-content">
        <ul id="search-results">
        </ul>
    </div>

    
<div class="row">
    <div class="col-md-3">
                <div id="navigation" class="list-group"><a class="list-group-item active" href="#navigation-12298" data-toggle="collapse" data-parent="#navigation">yii\debug <b class="caret"></b></a><div id="navigation-12298" class="submenu panel-collapse collapse in"><a class="list-group-item" href="./yii-debug-debugasset.html">DebugAsset</a>
<a class="list-group-item" href="./yii-debug-logtarget.html">LogTarget</a>
<a class="list-group-item active" href="./yii-debug-module.html">Module</a>
<a class="list-group-item" href="./yii-debug-panel.html">Panel</a></div>
<a class="list-group-item" href="#navigation-12299" data-toggle="collapse" data-parent="#navigation">yii\debug\actions\db <b class="caret"></b></a><div id="navigation-12299" class="submenu panel-collapse collapse"><a class="list-group-item" href="./yii-debug-actions-db-explainaction.html">ExplainAction</a></div>
<a class="list-group-item" href="#navigation-12300" data-toggle="collapse" data-parent="#navigation">yii\debug\components\search <b class="caret"></b></a><div id="navigation-12300" class="submenu panel-collapse collapse"><a class="list-group-item" href="./yii-debug-components-search-filter.html">Filter</a></div>
<a class="list-group-item" href="#navigation-12301" data-toggle="collapse" data-parent="#navigation">yii\debug\components\search\matchers <b class="caret"></b></a><div id="navigation-12301" class="submenu panel-collapse collapse"><a class="list-group-item" href="./yii-debug-components-search-matchers-base.html">Base</a>
<a class="list-group-item" href="./yii-debug-components-search-matchers-greaterthan.html">GreaterThan</a>
<a class="list-group-item" href="./yii-debug-components-search-matchers-lowerthan.html">LowerThan</a>
<a class="list-group-item" href="./yii-debug-components-search-matchers-matcherinterface.html">MatcherInterface</a>
<a class="list-group-item" href="./yii-debug-components-search-matchers-sameas.html">SameAs</a></div>
<a class="list-group-item" href="#navigation-12302" data-toggle="collapse" data-parent="#navigation">yii\debug\controllers <b class="caret"></b></a><div id="navigation-12302" class="submenu panel-collapse collapse"><a class="list-group-item" href="./yii-debug-controllers-defaultcontroller.html">DefaultController</a></div>
<a class="list-group-item" href="#navigation-12303" data-toggle="collapse" data-parent="#navigation">yii\debug\models\search <b class="caret"></b></a><div id="navigation-12303" class="submenu panel-collapse collapse"><a class="list-group-item" href="./yii-debug-models-search-base.html">Base</a>
<a class="list-group-item" href="./yii-debug-models-search-db.html">Db</a>
<a class="list-group-item" href="./yii-debug-models-search-debug.html">Debug</a>
<a class="list-group-item" href="./yii-debug-models-search-log.html">Log</a>
<a class="list-group-item" href="./yii-debug-models-search-mail.html">Mail</a>
<a class="list-group-item" href="./yii-debug-models-search-profile.html">Profile</a></div>
<a class="list-group-item" href="#navigation-12304" data-toggle="collapse" data-parent="#navigation">yii\debug\panels <b class="caret"></b></a><div id="navigation-12304" class="submenu panel-collapse collapse"><a class="list-group-item" href="./yii-debug-panels-assetpanel.html">AssetPanel</a>
<a class="list-group-item" href="./yii-debug-panels-configpanel.html">ConfigPanel</a>
<a class="list-group-item" href="./yii-debug-panels-dbpanel.html">DbPanel</a>
<a class="list-group-item" href="./yii-debug-panels-logpanel.html">LogPanel</a>
<a class="list-group-item" href="./yii-debug-panels-mailpanel.html">MailPanel</a>
<a class="list-group-item" href="./yii-debug-panels-profilingpanel.html">ProfilingPanel</a>
<a class="list-group-item" href="./yii-debug-panels-requestpanel.html">RequestPanel</a></div></div>    </div>
    <div class="col-md-9 api-content" role="main">
        <h1>Class yii\debug\Module</h1>
<div class="top-nav">
    <a href="index.html">All Classes</a>
            | <a href="#properties">Properties</a>
                | <a href="#methods">Methods</a>
                | <a href="#events">Events</a>
        </div>

<table class="summaryTable docClass table table-bordered">
    <colgroup>
        <col class="col-name" />
        <col class="col-value" />
    </colgroup>
            <tr><th>Inheritance</th><td><a href="yii-debug-module.html">yii\debug\Module</a> &raquo;
<a href="yii-base-module.html">yii\base\Module</a> &raquo;
<a href="yii-di-servicelocator.html">yii\di\ServiceLocator</a> &raquo;
<a href="yii-base-component.html">yii\base\Component</a> &raquo;
<a href="yii-base-object.html">yii\base\Object</a></td></tr>
                <tr><th>Implements</th><td><a href="yii-base-bootstrapinterface.html">yii\base\BootstrapInterface</a>, <a href="yii-base-configurable.html">yii\base\Configurable</a></td></tr>
                                    <tr><th>Available since version</th><td>2.0</td></tr>
                    <tr>
          <th>Source Code</th>
          <td><a href="https://github.com/yiisoft/yii2-debug/blob/master/Module.php">https://github.com/yiisoft/yii2-debug/blob/master/Module.php</a></td>
        </tr>
    </table>

<div class="class-description">
    <p><strong>The Yii Debug Module provides the debug toolbar and debugger</strong></p>
    
    </div>

<a id="properties"></a>

<div class="summary doc-property">
<h2>Public Properties</h2>

<p><a href="#" class="toggle">Hide inherited properties</a></p>

<table class="summary-table table table-striped table-bordered table-hover">
<colgroup>
    <col class="col-property" />
    <col class="col-type" />
    <col class="col-description" />
    <col class="col-defined" />
</colgroup>
<tr>
  <th>Property</th><th>Type</th><th>Description</th><th>Defined By</th>
</tr>
        <tr class="inherited" id="$aliases">
        <td><a href="yii-base-module.html#$aliases-detail">$aliases</a></td>
        <td><a href="http://www.php.net/language.types.array">array</a></td>
        <td>List of path aliases to be defined.</td>
        <td><a href="yii-base-module.html">yii\base\Module</a></td>
    </tr>
            <tr id="$allowedHosts">
        <td><a href="yii-debug-module.html#$allowedHosts-detail">$allowedHosts</a></td>
        <td><a href="http://www.php.net/language.types.array">array</a></td>
        <td>The list of hosts that are allowed to access this module.</td>
        <td><a href="yii-debug-module.html">yii\debug\Module</a></td>
    </tr>
            <tr id="$allowedIPs">
        <td><a href="yii-debug-module.html#$allowedIPs-detail">$allowedIPs</a></td>
        <td><a href="http://www.php.net/language.types.array">array</a></td>
        <td>The list of IPs that are allowed to access this module.</td>
        <td><a href="yii-debug-module.html">yii\debug\Module</a></td>
    </tr>
            <tr class="inherited" id="$basePath">
        <td><a href="yii-base-module.html#$basePath-detail">$basePath</a></td>
        <td><a href="http://www.php.net/language.types.string">string</a></td>
        <td>The root directory of the module.</td>
        <td><a href="yii-base-module.html">yii\base\Module</a></td>
    </tr>
            <tr class="inherited" id="$behaviors">
        <td><a href="yii-base-component.html#$behaviors-detail">$behaviors</a></td>
        <td><a href="yii-base-behavior.html">yii\base\Behavior</a>[]</td>
        <td>List of behaviors attached to this component</td>
        <td><a href="yii-base-component.html">yii\base\Component</a></td>
    </tr>
            <tr class="inherited" id="$components">
        <td><a href="yii-di-servicelocator.html#$components-detail">$components</a></td>
        <td><a href="http://www.php.net/language.types.array">array</a></td>
        <td>The list of the component definitions or the loaded component instances (ID =&gt; definition or instance).</td>
        <td><a href="yii-di-servicelocator.html">yii\di\ServiceLocator</a></td>
    </tr>
            <tr class="inherited" id="$controllerMap">
        <td><a href="yii-base-module.html#$controllerMap-detail">$controllerMap</a></td>
        <td><a href="http://www.php.net/language.types.array">array</a></td>
        <td>Mapping from controller ID to controller configurations.</td>
        <td><a href="yii-base-module.html">yii\base\Module</a></td>
    </tr>
            <tr id="$controllerNamespace">
        <td><a href="yii-debug-module.html#$controllerNamespace-detail">$controllerNamespace</a></td>
        <td><a href="http://www.php.net/language.types.string">string</a></td>
        <td>The namespace that controller classes are in.</td>
        <td><a href="yii-debug-module.html">yii\debug\Module</a></td>
    </tr>
            <tr class="inherited" id="$controllerPath">
        <td><a href="yii-base-module.html#$controllerPath-detail">$controllerPath</a></td>
        <td><a href="http://www.php.net/language.types.string">string</a></td>
        <td>The directory that contains the controller classes.</td>
        <td><a href="yii-base-module.html">yii\base\Module</a></td>
    </tr>
            <tr id="$dataPath">
        <td><a href="yii-debug-module.html#$dataPath-detail">$dataPath</a></td>
        <td><a href="http://www.php.net/language.types.string">string</a></td>
        <td>The directory storing the debugger data files.</td>
        <td><a href="yii-debug-module.html">yii\debug\Module</a></td>
    </tr>
            <tr class="inherited" id="$defaultRoute">
        <td><a href="yii-base-module.html#$defaultRoute-detail">$defaultRoute</a></td>
        <td><a href="http://www.php.net/language.types.string">string</a></td>
        <td>The default route of this module.</td>
        <td><a href="yii-base-module.html">yii\base\Module</a></td>
    </tr>
            <tr id="$dirMode">
        <td><a href="yii-debug-module.html#$dirMode-detail">$dirMode</a></td>
        <td><a href="http://www.php.net/language.types.integer">integer</a></td>
        <td>The permission to be set for newly created directories.</td>
        <td><a href="yii-debug-module.html">yii\debug\Module</a></td>
    </tr>
            <tr id="$enableDebugLogs">
        <td><a href="yii-debug-module.html#$enableDebugLogs-detail">$enableDebugLogs</a></td>
        <td><a href="http://www.php.net/language.types.boolean">boolean</a></td>
        <td>Whether to enable message logging for the requests about debug module actions.</td>
        <td><a href="yii-debug-module.html">yii\debug\Module</a></td>
    </tr>
            <tr id="$fileMode">
        <td><a href="yii-debug-module.html#$fileMode-detail">$fileMode</a></td>
        <td><a href="http://www.php.net/language.types.integer">integer</a></td>
        <td>The permission to be set for newly created debugger data files.</td>
        <td><a href="yii-debug-module.html">yii\debug\Module</a></td>
    </tr>
            <tr id="$historySize">
        <td><a href="yii-debug-module.html#$historySize-detail">$historySize</a></td>
        <td><a href="http://www.php.net/language.types.integer">integer</a></td>
        <td>The maximum number of debug data files to keep.</td>
        <td><a href="yii-debug-module.html">yii\debug\Module</a></td>
    </tr>
            <tr class="inherited" id="$id">
        <td><a href="yii-base-module.html#$id-detail">$id</a></td>
        <td><a href="http://www.php.net/language.types.string">string</a></td>
        <td>An ID that uniquely identifies this module among other modules which have the same <a href="yii-base-module.html#$module-detail">parent</a>.</td>
        <td><a href="yii-base-module.html">yii\base\Module</a></td>
    </tr>
            <tr class="inherited" id="$layout">
        <td><a href="yii-base-module.html#$layout-detail">$layout</a></td>
        <td><a href="http://www.php.net/language.types.string">string</a>|<a href="http://www.php.net/language.types.boolean">boolean</a></td>
        <td>The layout that should be applied for views within this module.</td>
        <td><a href="yii-base-module.html">yii\base\Module</a></td>
    </tr>
            <tr class="inherited" id="$layoutPath">
        <td><a href="yii-base-module.html#$layoutPath-detail">$layoutPath</a></td>
        <td><a href="http://www.php.net/language.types.string">string</a></td>
        <td>The root directory of layout files.</td>
        <td><a href="yii-base-module.html">yii\base\Module</a></td>
    </tr>
            <tr id="$logTarget">
        <td><a href="yii-debug-module.html#$logTarget-detail">$logTarget</a></td>
        <td><a href="yii-debug-logtarget.html">yii\debug\LogTarget</a></td>
        <td></td>
        <td><a href="yii-debug-module.html">yii\debug\Module</a></td>
    </tr>
            <tr class="inherited" id="$module">
        <td><a href="yii-base-module.html#$module-detail">$module</a></td>
        <td><a href="yii-base-module.html">yii\base\Module</a></td>
        <td>The parent module of this module.</td>
        <td><a href="yii-base-module.html">yii\base\Module</a></td>
    </tr>
            <tr class="inherited" id="$modules">
        <td><a href="yii-base-module.html#$modules-detail">$modules</a></td>
        <td><a href="http://www.php.net/language.types.array">array</a></td>
        <td>The modules (indexed by their IDs)</td>
        <td><a href="yii-base-module.html">yii\base\Module</a></td>
    </tr>
            <tr id="$panels">
        <td><a href="yii-debug-module.html#$panels-detail">$panels</a></td>
        <td><a href="http://www.php.net/language.types.array">array</a>|<a href="yii-debug-panel.html">yii\debug\Panel</a>[]</td>
        <td>List of debug panels.</td>
        <td><a href="yii-debug-module.html">yii\debug\Module</a></td>
    </tr>
            <tr class="inherited" id="$params">
        <td><a href="yii-base-module.html#$params-detail">$params</a></td>
        <td><a href="http://www.php.net/language.types.array">array</a></td>
        <td>Custom module parameters (name =&gt; value).</td>
        <td><a href="yii-base-module.html">yii\base\Module</a></td>
    </tr>
            <tr class="inherited" id="$uniqueId">
        <td><a href="yii-base-module.html#$uniqueId-detail">$uniqueId</a></td>
        <td><a href="http://www.php.net/language.types.string">string</a></td>
        <td>The unique ID of the module.</td>
        <td><a href="yii-base-module.html">yii\base\Module</a></td>
    </tr>
            <tr class="inherited" id="$viewPath">
        <td><a href="yii-base-module.html#$viewPath-detail">$viewPath</a></td>
        <td><a href="http://www.php.net/language.types.string">string</a></td>
        <td>The root directory of view files.</td>
        <td><a href="yii-base-module.html">yii\base\Module</a></td>
    </tr>
    </table>
</div>

<a id="methods"></a>

<div class="summary doc-method">
<h2>Public Methods</h2>

<p><a href="#" class="toggle">Hide inherited methods</a></p>

<table class="summary-table table table-striped table-bordered table-hover">
<colgroup>
    <col class="col-method" />
    <col class="col-description" />
    <col class="col-defined" />
</colgroup>
<tr>
  <th>Method</th><th>Description</th><th>Defined By</th>
</tr>
        <tr class="inherited" id="__call()">
        <td><a href="yii-base-component.html#__call()-detail">__call()</a></td>
        <td>Calls the named method which is not a class method.</td>
        <td><a href="yii-base-component.html">yii\base\Component</a></td>
    </tr>
            <tr class="inherited" id="__clone()">
        <td><a href="yii-base-component.html#__clone()-detail">__clone()</a></td>
        <td>This method is called after the object is created by cloning an existing one.</td>
        <td><a href="yii-base-component.html">yii\base\Component</a></td>
    </tr>
            <tr class="inherited" id="__construct()">
        <td><a href="yii-base-module.html#__construct()-detail">__construct()</a></td>
        <td>Constructor.</td>
        <td><a href="yii-base-module.html">yii\base\Module</a></td>
    </tr>
            <tr class="inherited" id="__get()">
        <td><a href="yii-base-component.html#__get()-detail">__get()</a></td>
        <td>Returns the value of a component property.</td>
        <td><a href="yii-base-component.html">yii\base\Component</a></td>
    </tr>
            <tr class="inherited" id="__isset()">
        <td><a href="yii-base-component.html#__isset()-detail">__isset()</a></td>
        <td>Checks if a property is set, i.e. defined and not null.</td>
        <td><a href="yii-base-component.html">yii\base\Component</a></td>
    </tr>
            <tr class="inherited" id="__set()">
        <td><a href="yii-base-component.html#__set()-detail">__set()</a></td>
        <td>Sets the value of a component property.</td>
        <td><a href="yii-base-component.html">yii\base\Component</a></td>
    </tr>
            <tr class="inherited" id="__unset()">
        <td><a href="yii-base-component.html#__unset()-detail">__unset()</a></td>
        <td>Sets a component property to be null.</td>
        <td><a href="yii-base-component.html">yii\base\Component</a></td>
    </tr>
            <tr class="inherited" id="afterAction()">
        <td><a href="yii-base-module.html#afterAction()-detail">afterAction()</a></td>
        <td>This method is invoked right after an action within this module is executed.</td>
        <td><a href="yii-base-module.html">yii\base\Module</a></td>
    </tr>
            <tr class="inherited" id="attachBehavior()">
        <td><a href="yii-base-component.html#attachBehavior()-detail">attachBehavior()</a></td>
        <td>Attaches a behavior to this component.</td>
        <td><a href="yii-base-component.html">yii\base\Component</a></td>
    </tr>
            <tr class="inherited" id="attachBehaviors()">
        <td><a href="yii-base-component.html#attachBehaviors()-detail">attachBehaviors()</a></td>
        <td>Attaches a list of behaviors to the component.</td>
        <td><a href="yii-base-component.html">yii\base\Component</a></td>
    </tr>
            <tr id="beforeAction()">
        <td><a href="yii-debug-module.html#beforeAction()-detail">beforeAction()</a></td>
        <td>This method is invoked right before an action within this module is executed.</td>
        <td><a href="yii-debug-module.html">yii\debug\Module</a></td>
    </tr>
            <tr class="inherited" id="behaviors()">
        <td><a href="yii-base-component.html#behaviors()-detail">behaviors()</a></td>
        <td>Returns a list of behaviors that this component should behave as.</td>
        <td><a href="yii-base-component.html">yii\base\Component</a></td>
    </tr>
            <tr id="bootstrap()">
        <td><a href="yii-debug-module.html#bootstrap()-detail">bootstrap()</a></td>
        <td>Bootstrap method to be called during application bootstrap stage.</td>
        <td><a href="yii-debug-module.html">yii\debug\Module</a></td>
    </tr>
            <tr class="inherited" id="canGetProperty()">
        <td><a href="yii-base-component.html#canGetProperty()-detail">canGetProperty()</a></td>
        <td>Returns a value indicating whether a property can be read.</td>
        <td><a href="yii-base-component.html">yii\base\Component</a></td>
    </tr>
            <tr class="inherited" id="canSetProperty()">
        <td><a href="yii-base-component.html#canSetProperty()-detail">canSetProperty()</a></td>
        <td>Returns a value indicating whether a property can be set.</td>
        <td><a href="yii-base-component.html">yii\base\Component</a></td>
    </tr>
                <tr class="inherited" id="className()">
        <td><a href="yii-base-object.html#className()-detail">className()</a></td>
        <td>Returns the fully qualified name of this class.</td>
        <td><a href="yii-base-object.html">yii\base\Object</a></td>
    </tr>
            <tr class="inherited" id="clear()">
        <td><a href="yii-di-servicelocator.html#clear()-detail">clear()</a></td>
        <td>Removes the component from the locator.</td>
        <td><a href="yii-di-servicelocator.html">yii\di\ServiceLocator</a></td>
    </tr>
                <tr class="inherited" id="createController()">
        <td><a href="yii-base-module.html#createController()-detail">createController()</a></td>
        <td>Creates a controller instance based on the given route.</td>
        <td><a href="yii-base-module.html">yii\base\Module</a></td>
    </tr>
            <tr class="inherited" id="createControllerByID()">
        <td><a href="yii-base-module.html#createControllerByID()-detail">createControllerByID()</a></td>
        <td>Creates a controller based on the given controller ID.</td>
        <td><a href="yii-base-module.html">yii\base\Module</a></td>
    </tr>
            <tr class="inherited" id="detachBehavior()">
        <td><a href="yii-base-component.html#detachBehavior()-detail">detachBehavior()</a></td>
        <td>Detaches a behavior from the component.</td>
        <td><a href="yii-base-component.html">yii\base\Component</a></td>
    </tr>
            <tr class="inherited" id="detachBehaviors()">
        <td><a href="yii-base-component.html#detachBehaviors()-detail">detachBehaviors()</a></td>
        <td>Detaches all behaviors from the component.</td>
        <td><a href="yii-base-component.html">yii\base\Component</a></td>
    </tr>
            <tr class="inherited" id="ensureBehaviors()">
        <td><a href="yii-base-component.html#ensureBehaviors()-detail">ensureBehaviors()</a></td>
        <td>Makes sure that the behaviors declared in <a href="yii-base-component.html#behaviors()-detail">behaviors()</a> are attached to this component.</td>
        <td><a href="yii-base-component.html">yii\base\Component</a></td>
    </tr>
            <tr class="inherited" id="get()">
        <td><a href="yii-di-servicelocator.html#get()-detail">get()</a></td>
        <td>Returns the component instance with the specified ID.</td>
        <td><a href="yii-di-servicelocator.html">yii\di\ServiceLocator</a></td>
    </tr>
            <tr class="inherited" id="getBasePath()">
        <td><a href="yii-base-module.html#getBasePath()-detail">getBasePath()</a></td>
        <td>Returns the root directory of the module.</td>
        <td><a href="yii-base-module.html">yii\base\Module</a></td>
    </tr>
            <tr class="inherited" id="getBehavior()">
        <td><a href="yii-base-component.html#getBehavior()-detail">getBehavior()</a></td>
        <td>Returns the named behavior object.</td>
        <td><a href="yii-base-component.html">yii\base\Component</a></td>
    </tr>
            <tr class="inherited" id="getBehaviors()">
        <td><a href="yii-base-component.html#getBehaviors()-detail">getBehaviors()</a></td>
        <td>Returns all behaviors attached to this component.</td>
        <td><a href="yii-base-component.html">yii\base\Component</a></td>
    </tr>
            <tr class="inherited" id="getComponents()">
        <td><a href="yii-di-servicelocator.html#getComponents()-detail">getComponents()</a></td>
        <td>Returns the list of the component definitions or the loaded component instances.</td>
        <td><a href="yii-di-servicelocator.html">yii\di\ServiceLocator</a></td>
    </tr>
            <tr class="inherited" id="getControllerPath()">
        <td><a href="yii-base-module.html#getControllerPath()-detail">getControllerPath()</a></td>
        <td>Returns the directory that contains the controller classes according to <a href="yii-base-module.html#$controllerNamespace-detail">$controllerNamespace</a>.</td>
        <td><a href="yii-base-module.html">yii\base\Module</a></td>
    </tr>
            <tr class="inherited" id="getInstance()">
        <td><a href="yii-base-module.html#getInstance()-detail">getInstance()</a></td>
        <td>Returns the currently requested instance of this module class.</td>
        <td><a href="yii-base-module.html">yii\base\Module</a></td>
    </tr>
            <tr class="inherited" id="getLayoutPath()">
        <td><a href="yii-base-module.html#getLayoutPath()-detail">getLayoutPath()</a></td>
        <td>Returns the directory that contains layout view files for this module.</td>
        <td><a href="yii-base-module.html">yii\base\Module</a></td>
    </tr>
            <tr class="inherited" id="getModule()">
        <td><a href="yii-base-module.html#getModule()-detail">getModule()</a></td>
        <td>Retrieves the child module of the specified ID.</td>
        <td><a href="yii-base-module.html">yii\base\Module</a></td>
    </tr>
            <tr class="inherited" id="getModules()">
        <td><a href="yii-base-module.html#getModules()-detail">getModules()</a></td>
        <td>Returns the sub-modules in this module.</td>
        <td><a href="yii-base-module.html">yii\base\Module</a></td>
    </tr>
            <tr class="inherited" id="getUniqueId()">
        <td><a href="yii-base-module.html#getUniqueId()-detail">getUniqueId()</a></td>
        <td>Returns an ID that uniquely identifies this module among all modules within the current application.</td>
        <td><a href="yii-base-module.html">yii\base\Module</a></td>
    </tr>
            <tr class="inherited" id="getViewPath()">
        <td><a href="yii-base-module.html#getViewPath()-detail">getViewPath()</a></td>
        <td>Returns the directory that contains the view files for this module.</td>
        <td><a href="yii-base-module.html">yii\base\Module</a></td>
    </tr>
            <tr id="getYiiLogo()">
        <td><a href="yii-debug-module.html#getYiiLogo()-detail">getYiiLogo()</a></td>
        <td>Returns Yii logo ready to use in <code>&lt;img src="</code></td>
        <td><a href="yii-debug-module.html">yii\debug\Module</a></td>
    </tr>
            <tr class="inherited" id="has()">
        <td><a href="yii-di-servicelocator.html#has()-detail">has()</a></td>
        <td>Returns a value indicating whether the locator has the specified component definition or has instantiated the component.</td>
        <td><a href="yii-di-servicelocator.html">yii\di\ServiceLocator</a></td>
    </tr>
            <tr class="inherited" id="hasEventHandlers()">
        <td><a href="yii-base-component.html#hasEventHandlers()-detail">hasEventHandlers()</a></td>
        <td>Returns a value indicating whether there is any handler attached to the named event.</td>
        <td><a href="yii-base-component.html">yii\base\Component</a></td>
    </tr>
            <tr class="inherited" id="hasMethod()">
        <td><a href="yii-base-component.html#hasMethod()-detail">hasMethod()</a></td>
        <td>Returns a value indicating whether a method is defined.</td>
        <td><a href="yii-base-component.html">yii\base\Component</a></td>
    </tr>
            <tr class="inherited" id="hasModule()">
        <td><a href="yii-base-module.html#hasModule()-detail">hasModule()</a></td>
        <td>Checks whether the child module of the specified ID exists.</td>
        <td><a href="yii-base-module.html">yii\base\Module</a></td>
    </tr>
            <tr class="inherited" id="hasProperty()">
        <td><a href="yii-base-component.html#hasProperty()-detail">hasProperty()</a></td>
        <td>Returns a value indicating whether a property is defined for this component.</td>
        <td><a href="yii-base-component.html">yii\base\Component</a></td>
    </tr>
            <tr id="init()">
        <td><a href="yii-debug-module.html#init()-detail">init()</a></td>
        <td>Initializes the module.</td>
        <td><a href="yii-debug-module.html">yii\debug\Module</a></td>
    </tr>
                <tr class="inherited" id="off()">
        <td><a href="yii-base-component.html#off()-detail">off()</a></td>
        <td>Detaches an existing event handler from this component.</td>
        <td><a href="yii-base-component.html">yii\base\Component</a></td>
    </tr>
            <tr class="inherited" id="on()">
        <td><a href="yii-base-component.html#on()-detail">on()</a></td>
        <td>Attaches an event handler to an event.</td>
        <td><a href="yii-base-component.html">yii\base\Component</a></td>
    </tr>
            <tr id="renderToolbar()">
        <td><a href="yii-debug-module.html#renderToolbar()-detail">renderToolbar()</a></td>
        <td>Renders mini-toolbar at the end of page body.</td>
        <td><a href="yii-debug-module.html">yii\debug\Module</a></td>
    </tr>
                <tr class="inherited" id="runAction()">
        <td><a href="yii-base-module.html#runAction()-detail">runAction()</a></td>
        <td>Runs a controller action specified by a route.</td>
        <td><a href="yii-base-module.html">yii\base\Module</a></td>
    </tr>
            <tr class="inherited" id="set()">
        <td><a href="yii-di-servicelocator.html#set()-detail">set()</a></td>
        <td>Registers a component definition with this locator.</td>
        <td><a href="yii-di-servicelocator.html">yii\di\ServiceLocator</a></td>
    </tr>
            <tr class="inherited" id="setAliases()">
        <td><a href="yii-base-module.html#setAliases()-detail">setAliases()</a></td>
        <td>Defines path aliases.</td>
        <td><a href="yii-base-module.html">yii\base\Module</a></td>
    </tr>
            <tr class="inherited" id="setBasePath()">
        <td><a href="yii-base-module.html#setBasePath()-detail">setBasePath()</a></td>
        <td>Sets the root directory of the module.</td>
        <td><a href="yii-base-module.html">yii\base\Module</a></td>
    </tr>
            <tr class="inherited" id="setComponents()">
        <td><a href="yii-di-servicelocator.html#setComponents()-detail">setComponents()</a></td>
        <td>Registers a set of component definitions in this locator.</td>
        <td><a href="yii-di-servicelocator.html">yii\di\ServiceLocator</a></td>
    </tr>
            <tr class="inherited" id="setInstance()">
        <td><a href="yii-base-module.html#setInstance()-detail">setInstance()</a></td>
        <td>Sets the currently requested instance of this module class.</td>
        <td><a href="yii-base-module.html">yii\base\Module</a></td>
    </tr>
            <tr class="inherited" id="setLayoutPath()">
        <td><a href="yii-base-module.html#setLayoutPath()-detail">setLayoutPath()</a></td>
        <td>Sets the directory that contains the layout files.</td>
        <td><a href="yii-base-module.html">yii\base\Module</a></td>
    </tr>
            <tr class="inherited" id="setModule()">
        <td><a href="yii-base-module.html#setModule()-detail">setModule()</a></td>
        <td>Adds a sub-module to this module.</td>
        <td><a href="yii-base-module.html">yii\base\Module</a></td>
    </tr>
            <tr class="inherited" id="setModules()">
        <td><a href="yii-base-module.html#setModules()-detail">setModules()</a></td>
        <td>Registers sub-modules in the current module.</td>
        <td><a href="yii-base-module.html">yii\base\Module</a></td>
    </tr>
            <tr class="inherited" id="setViewPath()">
        <td><a href="yii-base-module.html#setViewPath()-detail">setViewPath()</a></td>
        <td>Sets the directory that contains the view files.</td>
        <td><a href="yii-base-module.html">yii\base\Module</a></td>
    </tr>
            <tr class="inherited" id="trigger()">
        <td><a href="yii-base-component.html#trigger()-detail">trigger()</a></td>
        <td>Triggers an event.</td>
        <td><a href="yii-base-component.html">yii\base\Component</a></td>
    </tr>
    </table>
</div>

<div class="summary doc-method">
<h2>Protected Methods</h2>

<p><a href="#" class="toggle">Hide inherited methods</a></p>

<table class="summary-table table table-striped table-bordered table-hover">
<colgroup>
    <col class="col-method" />
    <col class="col-description" />
    <col class="col-defined" />
</colgroup>
<tr>
  <th>Method</th><th>Description</th><th>Defined By</th>
</tr>
                                                                    <tr id="checkAccess()">
        <td><a href="yii-debug-module.html#checkAccess()-detail">checkAccess()</a></td>
        <td>Checks if current user is allowed to access the module</td>
        <td><a href="yii-debug-module.html">yii\debug\Module</a></td>
    </tr>
                    <tr id="corePanels()">
        <td><a href="yii-debug-module.html#corePanels()-detail">corePanels()</a></td>
        <td></td>
        <td><a href="yii-debug-module.html">yii\debug\Module</a></td>
    </tr>
                                                                                                            <tr id="initPanels()">
        <td><a href="yii-debug-module.html#initPanels()-detail">initPanels()</a></td>
        <td>Initializes panels.</td>
        <td><a href="yii-debug-module.html">yii\debug\Module</a></td>
    </tr>
                        <tr id="resetGlobalSettings()">
        <td><a href="yii-debug-module.html#resetGlobalSettings()-detail">resetGlobalSettings()</a></td>
        <td>Resets potentially incompatible global settings done in app config.</td>
        <td><a href="yii-debug-module.html">yii\debug\Module</a></td>
    </tr>
                                                </table>
</div>

<a id="events"></a>
<div class="summary doc-event">
    <h2>Events</h2>

    <p><a href="#" class="toggle">Hide inherited events</a></p>

    <table class="summary-table table table-striped table-bordered table-hover">
    <colgroup>
        <col class="col-event" />
        <col class="col-type" />
        <col class="col-description" />
        <col class="col-defined" />
    </colgroup>
    <tr>
        <th>Event</th><th>Type</th><th>Description</th><th>Defined By</th>
    </tr>
        <tr class="inherited" id="EVENT_AFTER_ACTION">
        <td><a href="yii-base-module.html#EVENT_AFTER_ACTION-detail">EVENT_AFTER_ACTION</a></td>
        <td><a href="yii-base-actionevent.html">yii\base\ActionEvent</a></td>
        <td>
            An event raised after executing a controller action.                    </td>
        <td><a href="yii-base-module.html">yii\base\Module</a></td>
    </tr>
        <tr class="inherited" id="EVENT_BEFORE_ACTION">
        <td><a href="yii-base-module.html#EVENT_BEFORE_ACTION-detail">EVENT_BEFORE_ACTION</a></td>
        <td><a href="yii-base-actionevent.html">yii\base\ActionEvent</a></td>
        <td>
            An event raised before executing a controller action.                    </td>
        <td><a href="yii-base-module.html">yii\base\Module</a></td>
    </tr>
        </table>
</div>

<a id="constants"></a>

<h2>Property Details</h2>

<div class="property-doc">

    <div class="detail-header h3" id="$allowedHosts-detail">
        <a href="#" class="tool-link" title="go to top"><span class="glyphicon glyphicon-arrow-up"></span></a>
        <a class="tool-link hash" href="yii-debug-module.html#$allowedHosts-detail" title="direct link to this method"><span class="glyphicon icon-hash"></span></a>
                    <a href="https://github.com/yiisoft/yii2-debug/edit/master/Module.php#L40" class="tool-link" title="edit on github"><span class="glyphicon glyphicon-pencil"></span></a>
            <a href="https://github.com/yiisoft/yii2-debug/blob/master/Module.php#L40" class="tool-link" title="view source on github"><span class="glyphicon glyphicon-eye-open"></span></a>
        
        $allowedHosts        <span class="detail-header-tag small">
            public                                                property
                    </span>
    </div>

    <div class="doc-description">
        <p>The list of hosts that are allowed to access this module.
Each array element is a hostname that will be resolved to an IP address that is compared
with the IP address of the user. A use case is to use a dynamic DNS (DDNS) to allow access.
The default value is <code>[]</code>.</p>

            </div>

    <div class="signature"><span class="signature-defs">public</span> <span class="signature-type"><a href="http://www.php.net/language.types.array">array</a></span> <a href="yii-debug-module.html#$allowedHosts-detail">$allowedHosts</a> <span style="color: #0000BB"></span><span style="color: #007700">=&nbsp;[]</span></div>


    <div class="detail-header h3" id="$allowedIPs-detail">
        <a href="#" class="tool-link" title="go to top"><span class="glyphicon glyphicon-arrow-up"></span></a>
        <a class="tool-link hash" href="yii-debug-module.html#$allowedIPs-detail" title="direct link to this method"><span class="glyphicon icon-hash"></span></a>
                    <a href="https://github.com/yiisoft/yii2-debug/edit/master/Module.php#L33" class="tool-link" title="edit on github"><span class="glyphicon glyphicon-pencil"></span></a>
            <a href="https://github.com/yiisoft/yii2-debug/blob/master/Module.php#L33" class="tool-link" title="view source on github"><span class="glyphicon glyphicon-eye-open"></span></a>
        
        $allowedIPs        <span class="detail-header-tag small">
            public                                                property
                    </span>
    </div>

    <div class="doc-description">
        <p>The list of IPs that are allowed to access this module.
Each array element represents a single IP filter which can be either an IP address
or an address with wildcard (e.g. 192.168.0.*) to represent a network segment.
The default value is <code>['127.0.0.1', '::1']</code>, which means the module can only be accessed
by localhost.</p>

            </div>

    <div class="signature"><span class="signature-defs">public</span> <span class="signature-type"><a href="http://www.php.net/language.types.array">array</a></span> <a href="yii-debug-module.html#$allowedIPs-detail">$allowedIPs</a> <span style="color: #0000BB"></span><span style="color: #007700">=&nbsp;[</span><span style="color: #DD0000">'127.0.0.1'</span><span style="color: #007700">,&nbsp;</span><span style="color: #DD0000">'::1'</span><span style="color: #007700">]</span></div>


    <div class="detail-header h3" id="$controllerNamespace-detail">
        <a href="#" class="tool-link" title="go to top"><span class="glyphicon glyphicon-arrow-up"></span></a>
        <a class="tool-link hash" href="yii-debug-module.html#$controllerNamespace-detail" title="direct link to this method"><span class="glyphicon icon-hash"></span></a>
                    <a href="https://github.com/yiisoft/yii2-debug/edit/master/Module.php#L44" class="tool-link" title="edit on github"><span class="glyphicon glyphicon-pencil"></span></a>
            <a href="https://github.com/yiisoft/yii2-debug/blob/master/Module.php#L44" class="tool-link" title="view source on github"><span class="glyphicon glyphicon-eye-open"></span></a>
        
        $controllerNamespace        <span class="detail-header-tag small">
            public                                                property
                    </span>
    </div>

    <div class="doc-description">
        <p>The namespace that controller classes are in.
This namespace will be used to load controller classes by prepending it to the controller
class name.</p>
<p>If not set, it will use the <code>controllers</code> sub-namespace under the namespace of this module.
For example, if the namespace of this module is "foo\bar", then the default
controller namespace would be "foo\bar\controllers".</p>
<p>See also the <a href="./guide-concept-autoloading.html">guide section on autoloading</a> to learn more about
defining namespaces and how classes are loaded.</p>
<p>The namespace that controller classes are in.
This namespace will be used to load controller classes by prepending it to the controller
class name.</p>
<p>If not set, it will use the <code>controllers</code> sub-namespace under the namespace of this module.
For example, if the namespace of this module is "foo\bar", then the default
controller namespace would be "foo\bar\controllers".</p>
<p>See also the <a href="./guide-concept-autoloading.html">guide section on autoloading</a> to learn more about
defining namespaces and how classes are loaded.</p>

            </div>

    <div class="signature"><span class="signature-defs">public</span> <span class="signature-type"><a href="http://www.php.net/language.types.string">string</a></span> <a href="yii-debug-module.html#$controllerNamespace-detail">$controllerNamespace</a> <span style="color: #0000BB"></span><span style="color: #007700">=&nbsp;</span><span style="color: #DD0000">'yii\debug\controllers'</span></div>


    <div class="detail-header h3" id="$dataPath-detail">
        <a href="#" class="tool-link" title="go to top"><span class="glyphicon glyphicon-arrow-up"></span></a>
        <a class="tool-link hash" href="yii-debug-module.html#$dataPath-detail" title="direct link to this method"><span class="glyphicon icon-hash"></span></a>
                    <a href="https://github.com/yiisoft/yii2-debug/edit/master/Module.php#L59" class="tool-link" title="edit on github"><span class="glyphicon glyphicon-pencil"></span></a>
            <a href="https://github.com/yiisoft/yii2-debug/blob/master/Module.php#L59" class="tool-link" title="view source on github"><span class="glyphicon glyphicon-eye-open"></span></a>
        
        $dataPath        <span class="detail-header-tag small">
            public                                                property
                    </span>
    </div>

    <div class="doc-description">
        <p>The directory storing the debugger data files. This can be specified using a path alias.</p>

            </div>

    <div class="signature"><span class="signature-defs">public</span> <span class="signature-type"><a href="http://www.php.net/language.types.string">string</a></span> <a href="yii-debug-module.html#$dataPath-detail">$dataPath</a> <span style="color: #0000BB"></span><span style="color: #007700">=&nbsp;</span><span style="color: #DD0000">'@runtime/debug'</span></div>


    <div class="detail-header h3" id="$dirMode-detail">
        <a href="#" class="tool-link" title="go to top"><span class="glyphicon glyphicon-arrow-up"></span></a>
        <a class="tool-link hash" href="yii-debug-module.html#$dirMode-detail" title="direct link to this method"><span class="glyphicon icon-hash"></span></a>
                    <a href="https://github.com/yiisoft/yii2-debug/edit/master/Module.php#L74" class="tool-link" title="edit on github"><span class="glyphicon glyphicon-pencil"></span></a>
            <a href="https://github.com/yiisoft/yii2-debug/blob/master/Module.php#L74" class="tool-link" title="view source on github"><span class="glyphicon glyphicon-eye-open"></span></a>
        
        $dirMode        <span class="detail-header-tag small">
            public                                                property
                            (available since version 2.0.6)
                    </span>
    </div>

    <div class="doc-description">
        <p>The permission to be set for newly created directories.
This value will be used by PHP <span class="broken-link">\yii\debug\chmod()</span> function. No umask will be applied.
Defaults to 0775, meaning the directory is read-writable by owner and group,
but read-only for other users.</p>

            </div>

    <div class="signature"><span class="signature-defs">public</span> <span class="signature-type"><a href="http://www.php.net/language.types.integer">integer</a></span> <a href="yii-debug-module.html#$dirMode-detail">$dirMode</a> <span style="color: #0000BB"></span><span style="color: #007700">=&nbsp;</span><span style="color: #0000BB">509</span></div>


    <div class="detail-header h3" id="$enableDebugLogs-detail">
        <a href="#" class="tool-link" title="go to top"><span class="glyphicon glyphicon-arrow-up"></span></a>
        <a class="tool-link hash" href="yii-debug-module.html#$enableDebugLogs-detail" title="direct link to this method"><span class="glyphicon icon-hash"></span></a>
                    <a href="https://github.com/yiisoft/yii2-debug/edit/master/Module.php#L85" class="tool-link" title="edit on github"><span class="glyphicon glyphicon-pencil"></span></a>
            <a href="https://github.com/yiisoft/yii2-debug/blob/master/Module.php#L85" class="tool-link" title="view source on github"><span class="glyphicon glyphicon-eye-open"></span></a>
        
        $enableDebugLogs        <span class="detail-header-tag small">
            public                                                property
                    </span>
    </div>

    <div class="doc-description">
        <p>Whether to enable message logging for the requests about debug module actions.
You normally do not want to keep these logs because they may distract you from the logs about your applications.
You may want to enable the debug logs if you want to investigate how the debug module itself works.</p>

            </div>

    <div class="signature"><span class="signature-defs">public</span> <span class="signature-type"><a href="http://www.php.net/language.types.boolean">boolean</a></span> <a href="yii-debug-module.html#$enableDebugLogs-detail">$enableDebugLogs</a> <span style="color: #0000BB"></span><span style="color: #007700">=&nbsp;</span><span style="color: #0000BB">false</span></div>


    <div class="detail-header h3" id="$fileMode-detail">
        <a href="#" class="tool-link" title="go to top"><span class="glyphicon glyphicon-arrow-up"></span></a>
        <a class="tool-link hash" href="yii-debug-module.html#$fileMode-detail" title="direct link to this method"><span class="glyphicon icon-hash"></span></a>
                    <a href="https://github.com/yiisoft/yii2-debug/edit/master/Module.php#L66" class="tool-link" title="edit on github"><span class="glyphicon glyphicon-pencil"></span></a>
            <a href="https://github.com/yiisoft/yii2-debug/blob/master/Module.php#L66" class="tool-link" title="view source on github"><span class="glyphicon glyphicon-eye-open"></span></a>
        
        $fileMode        <span class="detail-header-tag small">
            public                                                property
                            (available since version 2.0.6)
                    </span>
    </div>

    <div class="doc-description">
        <p>The permission to be set for newly created debugger data files.
This value will be used by PHP <span class="broken-link">\yii\debug\chmod()</span> function. No umask will be applied.
If not set, the permission will be determined by the current environment.</p>

            </div>

    <div class="signature"><span class="signature-defs">public</span> <span class="signature-type"><a href="http://www.php.net/language.types.integer">integer</a></span> <a href="yii-debug-module.html#$fileMode-detail">$fileMode</a> <span style="color: #0000BB"></span><span style="color: #007700">=&nbsp;</span><span style="color: #0000BB">null</span></div>


    <div class="detail-header h3" id="$historySize-detail">
        <a href="#" class="tool-link" title="go to top"><span class="glyphicon glyphicon-arrow-up"></span></a>
        <a class="tool-link hash" href="yii-debug-module.html#$historySize-detail" title="direct link to this method"><span class="glyphicon icon-hash"></span></a>
                    <a href="https://github.com/yiisoft/yii2-debug/edit/master/Module.php#L79" class="tool-link" title="edit on github"><span class="glyphicon glyphicon-pencil"></span></a>
            <a href="https://github.com/yiisoft/yii2-debug/blob/master/Module.php#L79" class="tool-link" title="view source on github"><span class="glyphicon glyphicon-eye-open"></span></a>
        
        $historySize        <span class="detail-header-tag small">
            public                                                property
                    </span>
    </div>

    <div class="doc-description">
        <p>The maximum number of debug data files to keep. If there are more files generated,
the oldest ones will be removed.</p>

            </div>

    <div class="signature"><span class="signature-defs">public</span> <span class="signature-type"><a href="http://www.php.net/language.types.integer">integer</a></span> <a href="yii-debug-module.html#$historySize-detail">$historySize</a> <span style="color: #0000BB"></span><span style="color: #007700">=&nbsp;</span><span style="color: #0000BB">50</span></div>


    <div class="detail-header h3" id="$logTarget-detail">
        <a href="#" class="tool-link" title="go to top"><span class="glyphicon glyphicon-arrow-up"></span></a>
        <a class="tool-link hash" href="yii-debug-module.html#$logTarget-detail" title="direct link to this method"><span class="glyphicon icon-hash"></span></a>
                    <a href="https://github.com/yiisoft/yii2-debug/edit/master/Module.php#L48" class="tool-link" title="edit on github"><span class="glyphicon glyphicon-pencil"></span></a>
            <a href="https://github.com/yiisoft/yii2-debug/blob/master/Module.php#L48" class="tool-link" title="view source on github"><span class="glyphicon glyphicon-eye-open"></span></a>
        
        $logTarget        <span class="detail-header-tag small">
            public                                                property
                    </span>
    </div>

    <div class="doc-description">
        
            </div>

    <div class="signature"><span class="signature-defs">public</span> <span class="signature-type"><a href="yii-debug-logtarget.html">yii\debug\LogTarget</a></span> <a href="yii-debug-module.html#$logTarget-detail">$logTarget</a> <span style="color: #0000BB"></span><span style="color: #007700">=&nbsp;</span><span style="color: #0000BB">null</span></div>


    <div class="detail-header h3" id="$panels-detail">
        <a href="#" class="tool-link" title="go to top"><span class="glyphicon glyphicon-arrow-up"></span></a>
        <a class="tool-link hash" href="yii-debug-module.html#$panels-detail" title="direct link to this method"><span class="glyphicon icon-hash"></span></a>
                    <a href="https://github.com/yiisoft/yii2-debug/edit/master/Module.php#L55" class="tool-link" title="edit on github"><span class="glyphicon glyphicon-pencil"></span></a>
            <a href="https://github.com/yiisoft/yii2-debug/blob/master/Module.php#L55" class="tool-link" title="view source on github"><span class="glyphicon glyphicon-eye-open"></span></a>
        
        $panels        <span class="detail-header-tag small">
            public                                                property
                    </span>
    </div>

    <div class="doc-description">
        <p>List of debug panels. The array keys are the panel IDs, and values are the corresponding
panel class names or configuration arrays. This will be merged with <a href="yii-debug-module.html#corePanels()-detail">corePanels()</a>.
You may reconfigure a core panel via this property by using the same panel ID.
You may also disable a core panel by setting it to be false in this property.</p>

            </div>

    <div class="signature"><span class="signature-defs">public</span> <span class="signature-type"><a href="http://www.php.net/language.types.array">array</a>|<a href="yii-debug-panel.html">yii\debug\Panel</a>[]</span> <a href="yii-debug-module.html#$panels-detail">$panels</a> <span style="color: #0000BB"></span><span style="color: #007700">=&nbsp;[]</span></div>

</div>
<h2>Method Details</h2>

<div class="method-doc">

    <div class="detail-header h3" id="beforeAction()-detail">
        <a href="#" class="tool-link" title="go to top"><span class="glyphicon glyphicon-arrow-up"></span></a>
        <a class="tool-link hash" href="yii-debug-module.html#beforeAction()-detail" title="direct link to this method"><span class="glyphicon icon-hash"></span></a>
                    <a href="https://github.com/yiisoft/yii2-debug/edit/master/Module.php#L165" class="tool-link" title="edit on github"><span class="glyphicon glyphicon-pencil"></span></a>
            <a href="https://github.com/yiisoft/yii2-debug/blob/master/Module.php#L165" class="tool-link" title="view source on github"><span class="glyphicon glyphicon-eye-open"></span></a>
        
        beforeAction()
        <span class="detail-header-tag small">
            public                                    method
                    </span>
    </div>

    <div class="doc-description">
        <p><strong>This method is invoked right before an action within this module is executed.</strong></p>

        <p>The method will trigger the <a href="yii-base-module.html#EVENT_BEFORE_ACTION-detail">EVENT_BEFORE_ACTION</a> event. The return value of the method
will determine whether the action should continue to run.</p>
<p>In case the action should not run, the request should be handled inside of the <code>beforeAction</code> code
by either providing the necessary output or redirecting the request. Otherwise the response will be empty.</p>
<p>If you override this method, your code should look like the following:</p>
<pre><code class="hljs php language-php"><span class="hljs-keyword">public</span> <span class="hljs-function"><span class="hljs-keyword">function</span> <span class="hljs-title">beforeAction</span><span class="hljs-params">(<span class="hljs-variable">$action</span>)</span>
</span>{
    <span class="hljs-keyword">if</span> (!<span class="hljs-keyword">parent</span>::beforeAction(<span class="hljs-variable">$action</span>)) {
        <span class="hljs-keyword">return</span> <span class="hljs-keyword">false</span>;
    }

    <span class="hljs-comment">// your custom code here</span>

    <span class="hljs-keyword">return</span> <span class="hljs-keyword">true</span>; <span class="hljs-comment">// or false to not run the action</span>
}
</code></pre>

            </div>

    <table class="detail-table table table-striped table-bordered table-hover">
        <tr><td colspan="3" class="signature"><span class="signature-defs">public</span> <span class="signature-type"><a href="http://www.php.net/language.types.boolean">boolean</a></span> <strong><a href="yii-debug-module.html#beforeAction()-detail">beforeAction</a></strong> ( <span style="color: #0000BB">$action</span> )</td></tr>
                                    <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$action</span></td>
                  <td class="param-type-col"><a href="yii-base-action.html">yii\base\Action</a></td>
                  <td class="param-desc-col"><p>The action to be executed.</p>
</td>
                </tr>
                                        <tr>
                  <th class="param-name-col">return</th>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.boolean">boolean</a></td>
                  <td class="param-desc-col"><p>Whether the action should continue to be executed.</p>
</td>
                </tr>
                                    </table>

<!--	-->

    <div class="detail-header h3" id="bootstrap()-detail">
        <a href="#" class="tool-link" title="go to top"><span class="glyphicon glyphicon-arrow-up"></span></a>
        <a class="tool-link hash" href="yii-debug-module.html#bootstrap()-detail" title="direct link to this method"><span class="glyphicon icon-hash"></span></a>
                    <a href="https://github.com/yiisoft/yii2-debug/edit/master/Module.php#L139" class="tool-link" title="edit on github"><span class="glyphicon glyphicon-pencil"></span></a>
            <a href="https://github.com/yiisoft/yii2-debug/blob/master/Module.php#L139" class="tool-link" title="view source on github"><span class="glyphicon glyphicon-eye-open"></span></a>
        
        bootstrap()
        <span class="detail-header-tag small">
            public                                    method
                    </span>
    </div>

    <div class="doc-description">
        <p><strong>Bootstrap method to be called during application bootstrap stage.</strong></p>

        
            </div>

    <table class="detail-table table table-striped table-bordered table-hover">
        <tr><td colspan="3" class="signature"><span class="signature-defs">public</span> <span class="signature-type">void</span> <strong><a href="yii-debug-module.html#bootstrap()-detail">bootstrap</a></strong> ( <span style="color: #0000BB">$app</span> )</td></tr>
                                    <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$app</span></td>
                  <td class="param-type-col"><a href="yii-base-application.html">yii\base\Application</a></td>
                  <td class="param-desc-col"><p>The application currently running</p>
</td>
                </tr>
                                                </table>

<!--	-->

    <div class="detail-header h3" id="checkAccess()-detail">
        <a href="#" class="tool-link" title="go to top"><span class="glyphicon glyphicon-arrow-up"></span></a>
        <a class="tool-link hash" href="yii-debug-module.html#checkAccess()-detail" title="direct link to this method"><span class="glyphicon icon-hash"></span></a>
                    <a href="https://github.com/yiisoft/yii2-debug/edit/master/Module.php#L225" class="tool-link" title="edit on github"><span class="glyphicon glyphicon-pencil"></span></a>
            <a href="https://github.com/yiisoft/yii2-debug/blob/master/Module.php#L225" class="tool-link" title="view source on github"><span class="glyphicon glyphicon-eye-open"></span></a>
        
        checkAccess()
        <span class="detail-header-tag small">
            protected                                    method
                    </span>
    </div>

    <div class="doc-description">
        <p><strong>Checks if current user is allowed to access the module</strong></p>

        
            </div>

    <table class="detail-table table table-striped table-bordered table-hover">
        <tr><td colspan="3" class="signature"><span class="signature-defs">protected</span> <span class="signature-type"><a href="http://www.php.net/language.types.boolean">boolean</a></span> <strong><a href="yii-debug-module.html#checkAccess()-detail">checkAccess</a></strong> ( )</td></tr>
                                                <tr>
                  <th class="param-name-col">return</th>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.boolean">boolean</a></td>
                  <td class="param-desc-col"><p>If access is granted</p>
</td>
                </tr>
                                    </table>

<!--	-->

    <div class="detail-header h3" id="corePanels()-detail">
        <a href="#" class="tool-link" title="go to top"><span class="glyphicon glyphicon-arrow-up"></span></a>
        <a class="tool-link hash" href="yii-debug-module.html#corePanels()-detail" title="direct link to this method"><span class="glyphicon icon-hash"></span></a>
                    <a href="https://github.com/yiisoft/yii2-debug/edit/master/Module.php#L246" class="tool-link" title="edit on github"><span class="glyphicon glyphicon-pencil"></span></a>
            <a href="https://github.com/yiisoft/yii2-debug/blob/master/Module.php#L246" class="tool-link" title="view source on github"><span class="glyphicon glyphicon-eye-open"></span></a>
        
        corePanels()
        <span class="detail-header-tag small">
            protected                                    method
                    </span>
    </div>

    <div class="doc-description">
        <p><strong></strong></p>

        
            </div>

    <table class="detail-table table table-striped table-bordered table-hover">
        <tr><td colspan="3" class="signature"><span class="signature-defs">protected</span> <span class="signature-type"><a href="http://www.php.net/language.types.array">array</a></span> <strong><a href="yii-debug-module.html#corePanels()-detail">corePanels</a></strong> ( )</td></tr>
                                                <tr>
                  <th class="param-name-col">return</th>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.array">array</a></td>
                  <td class="param-desc-col"><p>Default set of panels</p>
</td>
                </tr>
                                    </table>

<!--	-->

    <div class="detail-header h3" id="getYiiLogo()-detail">
        <a href="#" class="tool-link" title="go to top"><span class="glyphicon glyphicon-arrow-up"></span></a>
        <a class="tool-link hash" href="yii-debug-module.html#getYiiLogo()-detail" title="direct link to this method"><span class="glyphicon icon-hash"></span></a>
                    <a href="https://github.com/yiisoft/yii2-debug/edit/master/Module.php#L93" class="tool-link" title="edit on github"><span class="glyphicon glyphicon-pencil"></span></a>
            <a href="https://github.com/yiisoft/yii2-debug/blob/master/Module.php#L93" class="tool-link" title="view source on github"><span class="glyphicon glyphicon-eye-open"></span></a>
        
        getYiiLogo()
        <span class="detail-header-tag small">
            public                        static            method
                    </span>
    </div>

    <div class="doc-description">
        <p><strong>Returns Yii logo ready to use in <code>&lt;img src="</code></strong></p>

        
            </div>

    <table class="detail-table table table-striped table-bordered table-hover">
        <tr><td colspan="3" class="signature"><span class="signature-defs">public static</span> <span class="signature-type"><a href="http://www.php.net/language.types.string">string</a></span> <strong><a href="yii-debug-module.html#getYiiLogo()-detail">getYiiLogo</a></strong> ( )</td></tr>
                                                <tr>
                  <th class="param-name-col">return</th>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.string">string</a></td>
                  <td class="param-desc-col"><p>Base64 representation of the image</p>
</td>
                </tr>
                                    </table>

<!--	-->

    <div class="detail-header h3" id="init()-detail">
        <a href="#" class="tool-link" title="go to top"><span class="glyphicon glyphicon-arrow-up"></span></a>
        <a class="tool-link hash" href="yii-debug-module.html#init()-detail" title="direct link to this method"><span class="glyphicon icon-hash"></span></a>
                    <a href="https://github.com/yiisoft/yii2-debug/edit/master/Module.php#L101" class="tool-link" title="edit on github"><span class="glyphicon glyphicon-pencil"></span></a>
            <a href="https://github.com/yiisoft/yii2-debug/blob/master/Module.php#L101" class="tool-link" title="view source on github"><span class="glyphicon glyphicon-eye-open"></span></a>
        
        init()
        <span class="detail-header-tag small">
            public                                    method
                    </span>
    </div>

    <div class="doc-description">
        <p><strong>Initializes the module.</strong></p>

        <p>This method is called after the module is created and initialized with property values
given in configuration. The default implementation will initialize <a href="yii-debug-module.html#$controllerNamespace-detail">$controllerNamespace</a>
if it is not set.</p>
<p>If you override this method, please make sure you call the parent implementation.</p>

            </div>

    <table class="detail-table table table-striped table-bordered table-hover">
        <tr><td colspan="3" class="signature"><span class="signature-defs">public</span> <span class="signature-type">void</span> <strong><a href="yii-debug-module.html#init()-detail">init</a></strong> ( )</td></tr>
            </table>

<!--	-->

    <div class="detail-header h3" id="initPanels()-detail">
        <a href="#" class="tool-link" title="go to top"><span class="glyphicon glyphicon-arrow-up"></span></a>
        <a class="tool-link hash" href="yii-debug-module.html#initPanels()-detail" title="direct link to this method"><span class="glyphicon icon-hash"></span></a>
                    <a href="https://github.com/yiisoft/yii2-debug/edit/master/Module.php#L111" class="tool-link" title="edit on github"><span class="glyphicon glyphicon-pencil"></span></a>
            <a href="https://github.com/yiisoft/yii2-debug/blob/master/Module.php#L111" class="tool-link" title="view source on github"><span class="glyphicon glyphicon-eye-open"></span></a>
        
        initPanels()
        <span class="detail-header-tag small">
            protected                                    method
                    </span>
    </div>

    <div class="doc-description">
        <p><strong>Initializes panels.</strong></p>

        
            </div>

    <table class="detail-table table table-striped table-bordered table-hover">
        <tr><td colspan="3" class="signature"><span class="signature-defs">protected</span> <span class="signature-type">void</span> <strong><a href="yii-debug-module.html#initPanels()-detail">initPanels</a></strong> ( )</td></tr>
            </table>

<!--	-->

    <div class="detail-header h3" id="renderToolbar()-detail">
        <a href="#" class="tool-link" title="go to top"><span class="glyphicon glyphicon-arrow-up"></span></a>
        <a class="tool-link hash" href="yii-debug-module.html#renderToolbar()-detail" title="direct link to this method"><span class="glyphicon icon-hash"></span></a>
                    <a href="https://github.com/yiisoft/yii2-debug/edit/master/Module.php#L204" class="tool-link" title="edit on github"><span class="glyphicon glyphicon-pencil"></span></a>
            <a href="https://github.com/yiisoft/yii2-debug/blob/master/Module.php#L204" class="tool-link" title="view source on github"><span class="glyphicon glyphicon-eye-open"></span></a>
        
        renderToolbar()
        <span class="detail-header-tag small">
            public                                    method
                    </span>
    </div>

    <div class="doc-description">
        <p><strong>Renders mini-toolbar at the end of page body.</strong></p>

        
            </div>

    <table class="detail-table table table-striped table-bordered table-hover">
        <tr><td colspan="3" class="signature"><span class="signature-defs">public</span> <span class="signature-type">void</span> <strong><a href="yii-debug-module.html#renderToolbar()-detail">renderToolbar</a></strong> ( <span style="color: #0000BB">$event</span> )</td></tr>
                                    <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$event</span></td>
                  <td class="param-type-col"><a href="yii-base-event.html">yii\base\Event</a></td>
                  <td class="param-desc-col"></td>
                </tr>
                                                </table>

<!--	-->

    <div class="detail-header h3" id="resetGlobalSettings()-detail">
        <a href="#" class="tool-link" title="go to top"><span class="glyphicon glyphicon-arrow-up"></span></a>
        <a class="tool-link hash" href="yii-debug-module.html#resetGlobalSettings()-detail" title="direct link to this method"><span class="glyphicon icon-hash"></span></a>
                    <a href="https://github.com/yiisoft/yii2-debug/edit/master/Module.php#L194" class="tool-link" title="edit on github"><span class="glyphicon glyphicon-pencil"></span></a>
            <a href="https://github.com/yiisoft/yii2-debug/blob/master/Module.php#L194" class="tool-link" title="view source on github"><span class="glyphicon glyphicon-eye-open"></span></a>
        
        resetGlobalSettings()
        <span class="detail-header-tag small">
            protected                                    method
                    </span>
    </div>

    <div class="doc-description">
        <p><strong>Resets potentially incompatible global settings done in app config.</strong></p>

        
            </div>

    <table class="detail-table table table-striped table-bordered table-hover">
        <tr><td colspan="3" class="signature"><span class="signature-defs">protected</span> <span class="signature-type">void</span> <strong><a href="yii-debug-module.html#resetGlobalSettings()-detail">resetGlobalSettings</a></strong> ( )</td></tr>
            </table>

<!--	-->
</div>
        </div>
</div>

<script type="text/javascript">
    /*<![CDATA[*/
    $("a.toggle").on('click', function () {
        var $this = $(this);
        if ($this.hasClass('properties-hidden')) {
            $this.text($this.text().replace(/Show/,'Hide'));
            $this.parents(".summary").find(".inherited").show();
            $this.removeClass('properties-hidden');
        } else {
            $this.text($this.text().replace(/Hide/,'Show'));
            $this.parents(".summary").find(".inherited").hide();
            $this.addClass('properties-hidden');
        }

        return false;
    });
    /*
     $(".sourceCode a.show").toggle(function () {
     $(this).text($(this).text().replace(/show/,'hide'));
     $(this).parents(".sourceCode").find("div.code").show();
     },function () {
     $(this).text($(this).text().replace(/hide/,'show'));
     $(this).parents(".sourceCode").find("div.code").hide();
     });
     $("a.sourceLink").click(function () {
     $(this).attr('target','_blank');
     });
     */
    /*]]>*/
</script>


</div>

<footer class="footer">
        <p class="pull-right"><small>Page generated on Sat, 09 Jul 2016 12:15:59 +0000</small></p>
    Powered by <a href="http://www.yiiframework.com/" rel="external">Yii Framework</a></footer>

<script type="text/javascript">jQuery(document).ready(function () {
    var shiftWindow = function () { scrollBy(0, -50) };
    if (location.hash) setTimeout(shiftWindow, 1);
    window.addEventListener("hashchange", shiftWindow);
var element = document.createElement("script");
element.src = "./jssearch.index.js";
document.body.appendChild(element);

var searchBox = $('#searchbox');

// search when typing in search field
searchBox.on("keyup", function(event) {
    var query = $(this).val();

    if (query == '' || event.which == 27) {
        $('#search-resultbox').hide();
        return;
    } else if (event.which == 13) {
        var selectedLink = $('#search-resultbox a.selected');
        if (selectedLink.length != 0) {
            document.location = selectedLink.attr('href');
            return;
        }
    } else if (event.which == 38 || event.which == 40) {
        $('#search-resultbox').show();

        var selected = $('#search-resultbox a.selected');
        if (selected.length == 0) {
            $('#search-results').find('a').first().addClass('selected');
        } else {
            var next;
            if (event.which == 40) {
                next = selected.parent().next().find('a').first();
            } else {
                next = selected.parent().prev().find('a').first();
            }
            if (next.length != 0) {
                var resultbox = $('#search-results');
                var position = next.position();

//              TODO scrolling is buggy and jumps around
//                resultbox.scrollTop(Math.floor(position.top));
//                console.log(position.top);

                selected.removeClass('selected');
                next.addClass('selected');
            }
        }

        return;
    }
    $('#search-resultbox').show();
    $('#search-results').html('<li><span class="no-results">No results</span></li>');

    var result = jssearch.search(query);

    if (result.length > 0) {
        var i = 0;
        var resHtml = '';

        for (var key in result) {
            if (i++ > 20) {
                break;
            }
            resHtml = resHtml +
            '<li><a href="' + result[key].file.u.substr(3) +'"><span class="title">' + result[key].file.t + '</span>' +
            '<span class="description">' + result[key].file.d + '</span></a></li>';
        }
        $('#search-results').html(resHtml);
    }
});

// hide the search results on ESC
$(document).on("keyup", function(event) { if (event.which == 27) { $('#search-resultbox').hide(); } });
// hide search results on click to document
$(document).bind('click', function (e) { $('#search-resultbox').hide(); });
// except the following:
searchBox.bind('click', function(e) { e.stopPropagation(); });
$('#search-resultbox').bind('click', function(e) { e.stopPropagation(); });

});</script></body>
</html>
